remark-lint-checkbox-character-style

remark-lint-checkbox-character-style

remark-lint rule to warn when list item checkboxes violate a given style.

Contents

• What is this?
• When should I use this?
• Presets
• Install
• Use
• API
  • unified().use(remarkLintCheckboxCharacterStyle[, config])
• Recommendation
• Fix
• Examples
• Compatibility
• Contribute
• License

What is this?

This package is a unified (remark) plugin, specifically a remark-lint rule. Lint rules check markdown code style.

When should I use this?

You can use this package to check that the style of GFM tasklists is consistent.

Presets

This rule is included in the following presets:

Preset	Setting
remark-preset-lint-consistent	'consistent'

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install remark-lint-checkbox-character-style

In Deno with esm.sh:

import remarkLintCheckboxCharacterStyle from 'https://esm.sh/remark-lint-checkbox-character-style@4'

In browsers with esm.sh:

<script type="module">
  import remarkLintCheckboxCharacterStyle from 'https://esm.sh/remark-lint-checkbox-character-style@4?bundle'
</script>

Use

On the API:

import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {remark} from 'remark'
import remarkLint from 'remark-lint'
import remarkLintCheckboxCharacterStyle from 'remark-lint-checkbox-character-style'

main()

async function main() {
  const file = await remark()
    .use(remarkLint)
    .use(remarkLintCheckboxCharacterStyle)
    .process(await read('example.md'))

  console.error(reporter(file))
}

On the CLI:

remark --use remark-lint --use remark-lint-checkbox-character-style example.md

On the CLI in a config file (here a package.json):

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-checkbox-character-style",
     …
   ]
 }
 …

API

This package exports no identifiers. The default export is remarkLintCheckboxCharacterStyle.

unified().use(remarkLintCheckboxCharacterStyle[, config])

This rule supports standard configuration that all remark lint rules accept (such as false to turn it off or [1, options] to configure it).

The following options (default: 'consistent') are accepted:

• Object with the following fields:
  • checked ('x', 'X', or 'consistent', default: 'consistent') — preferred character to use for checked checkboxes
  • unchecked ('·' (a space), '»' (a tab), or 'consistent', default: 'consistent') — preferred character to use for unchecked checkboxes
• 'consistent' — detect the first used styles and warn when further checkboxes differ

Recommendation

It’s recommended to set options.checked to 'x' (a lowercase X) as it prevents an extra keyboard press and options.unchecked to '·' (a space) to make all checkboxes align.

Fix

remark-stringify formats checked checkboxes using 'x' (lowercase X) and unchecked checkboxes using '·' (a space).

Examples

ok.md

When configured with { checked: 'x' }.

In

👉 Note: this example uses GFM (remark-gfm).

- [x] List item
- [x] List item

Out

No messages.

ok.md

When configured with { checked: 'X' }.

In

👉 Note: this example uses GFM (remark-gfm).

- [X] List item
- [X] List item

Out

No messages.

ok.md

When configured with { unchecked: ' ' }.

In

👉 Note: this example uses GFM (remark-gfm).

👉 Note: · represents a space.

- [ ] List item
- [ ] List item
- [ ]··
- [ ]

Out

No messages.

ok.md

When configured with { unchecked: '\t' }.

In

👉 Note: this example uses GFM (remark-gfm).

👉 Note: » represents a tab.

- [»] List item
- [»] List item

Out

No messages.

not-ok.md

In

👉 Note: this example uses GFM (remark-gfm).

👉 Note: » represents a tab.

- [x] List item
- [X] List item
- [ ] List item
- [»] List item

Out

2:5: Checked checkboxes should use `x` as a marker
4:5: Unchecked checkboxes should use ` ` as a marker

not-ok.md

When configured with { unchecked: '💩' }.

Out

1:1: Incorrect unchecked checkbox marker `💩`: use either `'\t'`, or `' '`

not-ok.md

When configured with { checked: '💩' }.

Out

1:1: Incorrect checked checkbox marker `💩`: use either `'x'`, or `'X'`

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

Contribute

See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer